/*
 * Copyright (c) 2009, Hamish Morgan. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the University of Sussex nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package locusts.server.behaviours;

import javax.vecmath.Vector2d;
import locusts.common.entities.Actor;
import locusts.common.entities.EntityList;

/**
 * <tt>Behaviour</tt> is a steering interface that a vehicle must
 * implement. It defines a single method that takes a Particle2f object
 * and returns a vector giving the direction that vehicle wishes to
 * travel in.
 *
 * @author Hamish Morgan Morgan
 */
public interface Behaviour {

    /**
     * Calculate a steering vector for the Vehicle given in the parameter.
     * 
     * @param vehicle   The entity for steering to be calculated for.
     * @return  The steering vector
     */
    Vector2d getSteering(final Actor vehicle);

    public void initialize(EntityList entities);

    public void clean();

    /**
     * Mutator to set the importance that this Behaviour has.
     *
     * @param weight
     */
    void setWeight(double weight);

    /**
     * Return the weight (of importance) that this Behaviour relative to
     * others.
     *
     * @return
     */
    double getWeight();
}
